home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / tgrind.zip / TGRIND.HLP < prev    next >
Text File  |  1990-05-22  |  3KB  |  139 lines
  1.  
  2.  
  3.  
  4. TGRIND(1)           UNIX Programmer's Manual            TGRIND(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      tgrind - grind nice program listings using TeX
  10.  
  11. SYNOPSIS
  12.      tgrind [ -f ] [ - ] [ -n ] [ -h header ] [ -d <description
  13.      file> ] [ -l<language> ] name ...
  14.  
  15. DESCRIPTION
  16.      T_g_r_i_n_d formats program sources in a nice style using _T_e_X(_1).
  17.      Comments are placed in italics, keywords in bold face and
  18.      strings in typewriter font.  Source file line numbers appear
  19.      in the right margin (every 10 lines).  The start of a func-
  20.      tion is indicated by the function name in large type in the
  21.      right margin.
  22.  
  23.      In regular mode t_g_r_i_n_d processes its input file(s) and
  24.      passes them to T_e_X(_1) for formating and output.
  25.  
  26.      In format mode (i.e., when the -f flag is used), t_g_r_i_n_d
  27.      processes its input file(s) and writes the result to stan-
  28.      dard output.  This output can be saved for later editting,
  29.      inclusion in a larger document, etc.
  30.  
  31.      The options are:
  32.  
  33.      -f   forces format mode
  34.  
  35.      -    take input from standard input
  36.  
  37.      -n   don't boldface keywords
  38.  
  39.      -h   specifies text to go on the left side of every output
  40.           page (default is none)
  41.  
  42.      -d   specifies the language definitions file (default is
  43.           /usr/local/lib/vgrindefs)
  44.  
  45.      -l   specifies the language to use.  Currently known are
  46.           PASCAL (-lp), RATFOR (-lr), Modula-2 (-lm2), MODEL (-
  47.           lm), C (-lc or the default), ISP (-li), Yacc (-ly),
  48.           Prolog (-lprolog), Icon (-lI), TeX (-ltex), CSH (-
  49.           lcsh), and Bourne Shell (-lsh).
  50.  
  51. FILES
  52.      tgrindmac.tex       macro package
  53.      /usr/local/lib/tfontedprpreprocessor
  54.      /usr/local/lib/vgrindefslanguage descriptions
  55.  
  56. AUTHOR
  57.      Van Jacobson, Lawrence Berkeley Laboratory (based on
  58.      "vgrind" by Dave Presotto & William Joy of UC Berkeley).
  59.  
  60.  
  61.  
  62.  
  63. Printed 12/10/86                                                1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. TGRIND(1)           UNIX Programmer's Manual            TGRIND(1)
  71.  
  72.  
  73.  
  74. SEE ALSO
  75.      tex(1), vgrind(1), vgrindefs(5)
  76.  
  77. BUGS
  78.      The marginal-function-name mechanism depends on the quality
  79.      of the language description in v_g_r_i_n_d_e_f_s.  The distributed
  80.      v_g_r_i_n_d_e_f_s fails to recognize many legal C function declara-
  81.      tions.
  82.  
  83.      Arbitrary formatting styles for programs mostly look bad.
  84.      The use of spaces to align source code often fails miserably
  85.      (because of the variable width output font).  If you plan to
  86.      t_g_r_i_n_d your program, try to use tabs.
  87.  
  88.      The indexing option of v_g_r_i_n_d is missing.  However, nice
  89.      indices can be generated using the -v option of c_t_a_g_s
  90.      together with appropriate TeX macros.
  91.  
  92.      The -f flag means different things to t_g_r_i_n_d and _v_g_r_i_n_d.
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129. Printed 12/10/86                                                2
  130.  
  131.  
  132.  
  133. program, try to use tabs.
  134.  
  135.      The indexing option of v_g_r_i_n_d is missing.  However, nice
  136.      indices can be generated using the -v option of c_t_a_g_s
  137.      together with appropriate TeX macros.
  138.  
  139.      The -f flag means different things to t_g_r